Update swagger docs with declaration endpoints #1504
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
padv2010
force-pushed
the
CPDLP-3103-ts-7-update-swagger-docs-with-declaration-endpoints
branch
from
0c458ac
to
f923fad
Compare
padv2010
changed the title
ethax-ross
reviewed
Jul 4, 2024
spec/support/shared_examples/api_create_on_resource_endpoint_documentation_support.rb
Show resolved
Hide resolved
spec/swagger_schemas/requests/participant_declaration_completed_request.rb
Show resolved
Hide resolved
leandroalemao
force-pushed
the
CPDLP-3094
branch
2 times, most recently
from
5aa4ff6
to
c871d86
Compare
padv2010
force-pushed
the
CPDLP-3103-ts-7-update-swagger-docs-with-declaration-endpoints
branch
3 times, most recently
from
9b01e9e
to
f5275af
Compare
|
Review app deployed to https://npq-registration-review-1504-web.test.teacherservices.cloud/ |
padv2010
force-pushed
the
CPDLP-3103-ts-7-update-swagger-docs-with-declaration-endpoints
branch
from
8d5c34e
to
82e7d2c
Compare
leandroalemao
approved these changes
Jul 8, 2024
cwrw
reviewed
Jul 9, 2024
| it_behaves_like "an API update endpoint documentation", | ||
| "/api/v1/participant-declarations/{id}/void", | ||
| "Participant declarations", | ||
| "Void a declaration", |
There was a problem hiding this comment.
could voided declarations have examples returned with voided state?
cwrw
reviewed
Jul 9, 2024
| } | ||
| h[:v3][:properties][:attributes][:properties][:lead_provider_name] = { | ||
| description: "The name of the provider that submitted the declaration", | ||
| type: "string", |
There was a problem hiding this comment.
can we add an example to lead provider as it's coming up as string
cwrw
reviewed
Jul 9, 2024
| description: "The type of course the participant is enrolled in", | ||
| type: :string, | ||
| required: true, | ||
| enum: %w[ |
There was a problem hiding this comment.
could we use Course::IDENTIFIERS and Course::IDENTIFIERS.first here similar to declarations?
cwrw
reviewed
Jul 9, 2024
| description: "The type of course the participant is enrolled in", | ||
| type: :string, | ||
| required: true, | ||
| enum: %w[ |
There was a problem hiding this comment.
same here and in the completed declaration request?
cwrw
reviewed
Jul 9, 2024
… correctly for void
mooktakim
force-pushed
the
CPDLP-3103-ts-7-update-swagger-docs-with-declaration-endpoints
branch
from
ef37705
to
82b3792
Compare
mooktakim
deleted the
CPDLP-3103-ts-7-update-swagger-docs-with-declaration-endpoints
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Ticket: https://dfedigital.atlassian.net/browse/CPDLP-3103
Description
Add API docs for all the declaration endpoints in NPQ in v1/v2/v3 for the GET/POST participant-declarations in all versions including any errors as in About the API - Manage training for early career teachers . Add the PUT void declarations in all versions.